Skip to content

chore(deps): resolve mkdocstrings breaks pymdown-extensions - #324

Merged
ktro2828 merged 1 commit into
tier4:mainfrom
ktro2828:docs/mkdocstring-breakdown
Oct 27, 2026
Merged

ktro2828 merged 1 commit into
tier4:mainfrom
ktro2828:docs/mkdocstring-breakdown

Conversation

@ktro2828

Copy link
Copy Markdown
Contributor

What

This pull request resolves the following error related to mkdocs:

ERROR   -  Error reading page 'apis/dataclass.md': Highlight.__init__() missing 1 required positional argument: 'md'
Traceback (most recent call last):
  File "/home/ktro2828/workspace/t4-devkit/.venv/bin/mkdocs", line 10, in <module>
    sys.exit(cli())
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/click/core.py", line 1631, in __call__
    return self.main(*args, **kwargs)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/click/core.py", line 1552, in main
    rv = self.invoke(ctx)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/click/core.py", line 2032, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/click/core.py", line 1415, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/click/core.py", line 910, in invoke
    return callback(*args, **kwargs)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/__main__.py", line 272, in serve_command
    serve.serve(**kwargs)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 85, in serve
    builder(config)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 67, in builder
    build(config, serve_url=None if is_clean else serve_url, dirty=is_dirty)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/commands/build.py", line 310, in build
    _populate_page(file.page, config, files, dirty)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/commands/build.py", line 167, in _populate_page
    page.render(config, files)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocs/structure/pages.py", line 285, in render
    self.content = md.convert(self.markdown)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/markdown/core.py", line 363, in convert
    root = self.parser.parseDocument(self.lines).getroot()
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/markdown/blockparser.py", line 117, in parseDocument
    self.parseChunk(self.root, '\n'.join(lines))
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/markdown/blockparser.py", line 136, in parseChunk
    self.parseBlocks(parent, text.split('\n\n'))
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/markdown/blockparser.py", line 158, in parseBlocks
    if processor.run(parent, blocks) is not False:
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocstrings/_internal/extension.py", line 127, in run
    html, handler, _ = self._process_block(identifier, block, heading_level)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocstrings/_internal/extension.py", line 185, in _process_block
    handler._update_env(self.md, config=self._handlers._tool_config)
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocstrings/_internal/handlers/base.py", line 491, in _update_env
    self.env.filters["highlight"] = Highlighter(new_md).highlight
  File "/home/ktro2828/workspace/t4-devkit/.venv/lib/python3.10/site-packages/mkdocstrings/_internal/handlers/rendering.py", line 85, in __init__
    super().__init__(**{name: opt for name, opt in config.items() if name in self._highlight_config_keys})
TypeError: Highlight.__init__() missing 1 required positional argument: 'md'

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
@ktro2828
ktro2828 merged commit 1b35a05 into tier4:main Oct 27, 2026
4 of 5 checks passed
@ktro2828
ktro2828 deleted the docs/mkdocstring-breakdown branch October 27, 2026 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant